<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__pdm__pcm__functions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#groups">API Reference</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Functions<div class="ingroups"><a class="el" href="group__group__pdm__pcm.html">PDM_PCM      (PDM-PCM Converter)</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
API Reference</h2></td></tr>
<tr class="memitem:group__group__pdm__pcm__functions__syspm__callback"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions__syspm__callback.html">Low Power Callback</a></td></tr>
<tr class="memdesc:group__group__pdm__pcm__functions__syspm__callback"><td class="mdescLeft">&#160;</td><td class="mdescRight">The driver supports SysPm callback for Deep Sleep transition. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga72f994cbd634988b0016f464720b3559"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__pdm__pcm__enums.html#ga8ef640550e81684b9c1b7a8af1cfd355">cy_en_pdm_pcm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga72f994cbd634988b0016f464720b3559">Cy_PDM_PCM_Init</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base, <a class="el" href="structcy__stc__pdm__pcm__config__t.html">cy_stc_pdm_pcm_config_t</a> const *config)</td></tr>
<tr class="memdesc:ga72f994cbd634988b0016f464720b3559"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the PDM-PCM module.  <a href="#ga72f994cbd634988b0016f464720b3559">More...</a><br /></td></tr>
<tr class="separator:ga72f994cbd634988b0016f464720b3559"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab516ee1cbdb2327b995d6ea079ad6209"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#gab516ee1cbdb2327b995d6ea079ad6209">Cy_PDM_PCM_DeInit</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base)</td></tr>
<tr class="memdesc:gab516ee1cbdb2327b995d6ea079ad6209"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uninitializes the PDM-PCM module.  <a href="#gab516ee1cbdb2327b995d6ea079ad6209">More...</a><br /></td></tr>
<tr class="separator:gab516ee1cbdb2327b995d6ea079ad6209"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4ea860b9ffa3f8c9fd3fcd1d42a6df8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga4ea860b9ffa3f8c9fd3fcd1d42a6df8a">Cy_PDM_PCM_SetGain</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base, <a class="el" href="group__group__pdm__pcm__enums.html#ga3f28a6dc09f7e9046984e99400290ec5">cy_en_pdm_pcm_chan_select_t</a> chan, <a class="el" href="group__group__pdm__pcm__enums.html#gaadc731486c068307198cd76e1283432f">cy_en_pdm_pcm_gain_t</a> gain)</td></tr>
<tr class="memdesc:ga4ea860b9ffa3f8c9fd3fcd1d42a6df8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the gain factor to the left or right channel.  <a href="#ga4ea860b9ffa3f8c9fd3fcd1d42a6df8a">More...</a><br /></td></tr>
<tr class="separator:ga4ea860b9ffa3f8c9fd3fcd1d42a6df8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70509bf557fcfc3232d29f2f409f86cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__pdm__pcm__enums.html#gaadc731486c068307198cd76e1283432f">cy_en_pdm_pcm_gain_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga70509bf557fcfc3232d29f2f409f86cb">Cy_PDM_PCM_GetGain</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *base, <a class="el" href="group__group__pdm__pcm__enums.html#ga3f28a6dc09f7e9046984e99400290ec5">cy_en_pdm_pcm_chan_select_t</a> chan)</td></tr>
<tr class="memdesc:ga70509bf557fcfc3232d29f2f409f86cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the current gain factor of the left or right channel.  <a href="#ga70509bf557fcfc3232d29f2f409f86cb">More...</a><br /></td></tr>
<tr class="separator:ga70509bf557fcfc3232d29f2f409f86cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4c9af29264496305f3d53886fda26b94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga4c9af29264496305f3d53886fda26b94">Cy_PDM_PCM_DeepSleepCallback</a> (<a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> const *callbackParams, <a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a> <a class="el" href="group__group__ipc__bt__data__structures.html#ga37e90f5e3bd99fac2021fb3a326607d4">mode</a>)</td></tr>
<tr class="memdesc:ga4c9af29264496305f3d53886fda26b94"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is an example callback function that can be used at the application layer to manage the PDM-PCM operation before entering and after exiting Deep Sleep mode.  <a href="#ga4c9af29264496305f3d53886fda26b94">More...</a><br /></td></tr>
<tr class="separator:ga4c9af29264496305f3d53886fda26b94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga23a191df6d51589e9d459e51a6a7af8b"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga23a191df6d51589e9d459e51a6a7af8b">Cy_PDM_PCM_Enable</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base)</td></tr>
<tr class="memdesc:ga23a191df6d51589e9d459e51a6a7af8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the PDM-PCM data conversion.  <a href="#ga23a191df6d51589e9d459e51a6a7af8b">More...</a><br /></td></tr>
<tr class="separator:ga23a191df6d51589e9d459e51a6a7af8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga16636b0a3e4032d53b595525e5c34de3"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga16636b0a3e4032d53b595525e5c34de3">Cy_PDM_PCM_Disable</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base)</td></tr>
<tr class="memdesc:ga16636b0a3e4032d53b595525e5c34de3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the PDM-PCM data conversion.  <a href="#ga16636b0a3e4032d53b595525e5c34de3">More...</a><br /></td></tr>
<tr class="separator:ga16636b0a3e4032d53b595525e5c34de3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaecd6316cef42b4c9d31b38aad0c222e6"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#gaecd6316cef42b4c9d31b38aad0c222e6">Cy_PDM_PCM_SetInterruptMask</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base, uint32_t interrupt)</td></tr>
<tr class="memdesc:gaecd6316cef42b4c9d31b38aad0c222e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets one or more PDM-PCM interrupt factor bits (sets the INTR_MASK register).  <a href="#gaecd6316cef42b4c9d31b38aad0c222e6">More...</a><br /></td></tr>
<tr class="separator:gaecd6316cef42b4c9d31b38aad0c222e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga083bc3c1e12b8f305cc762d03fa47f0f"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga083bc3c1e12b8f305cc762d03fa47f0f">Cy_PDM_PCM_GetInterruptMask</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *base)</td></tr>
<tr class="memdesc:ga083bc3c1e12b8f305cc762d03fa47f0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the PDM-PCM interrupt mask (a content of the INTR_MASK register).  <a href="#ga083bc3c1e12b8f305cc762d03fa47f0f">More...</a><br /></td></tr>
<tr class="separator:ga083bc3c1e12b8f305cc762d03fa47f0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacb7aa88956b61348b096897f16e969c4"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#gacb7aa88956b61348b096897f16e969c4">Cy_PDM_PCM_GetInterruptStatusMasked</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *base)</td></tr>
<tr class="memdesc:gacb7aa88956b61348b096897f16e969c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the status of enabled (masked) PDM-PCM interrupt sources.  <a href="#gacb7aa88956b61348b096897f16e969c4">More...</a><br /></td></tr>
<tr class="separator:gacb7aa88956b61348b096897f16e969c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65ff50ea418ef957c66f37ce6737ec0a"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga65ff50ea418ef957c66f37ce6737ec0a">Cy_PDM_PCM_GetInterruptStatus</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *base)</td></tr>
<tr class="memdesc:ga65ff50ea418ef957c66f37ce6737ec0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the status of PDM-PCM interrupt sources (an INTR register).  <a href="#ga65ff50ea418ef957c66f37ce6737ec0a">More...</a><br /></td></tr>
<tr class="separator:ga65ff50ea418ef957c66f37ce6737ec0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9519b93d2271e63fc4fbce99cc555d5e"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga9519b93d2271e63fc4fbce99cc555d5e">Cy_PDM_PCM_ClearInterrupt</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base, uint32_t interrupt)</td></tr>
<tr class="memdesc:ga9519b93d2271e63fc4fbce99cc555d5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears one or more PDM-PCM interrupt statuses (sets an INTR register's bits).  <a href="#ga9519b93d2271e63fc4fbce99cc555d5e">More...</a><br /></td></tr>
<tr class="separator:ga9519b93d2271e63fc4fbce99cc555d5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3692d34425f88eb231a24a48602027c"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#gac3692d34425f88eb231a24a48602027c">Cy_PDM_PCM_SetInterrupt</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base, uint32_t interrupt)</td></tr>
<tr class="memdesc:gac3692d34425f88eb231a24a48602027c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets one or more interrupt source statuses (sets an INTR_SET register).  <a href="#gac3692d34425f88eb231a24a48602027c">More...</a><br /></td></tr>
<tr class="separator:gac3692d34425f88eb231a24a48602027c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeee49f0677e0c628aa869f7d7a332a94"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#gaeee49f0677e0c628aa869f7d7a332a94">Cy_PDM_PCM_GetNumInFifo</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *base)</td></tr>
<tr class="memdesc:gaeee49f0677e0c628aa869f7d7a332a94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the current number of used words in the output data FIFO.  <a href="#gaeee49f0677e0c628aa869f7d7a332a94">More...</a><br /></td></tr>
<tr class="separator:gaeee49f0677e0c628aa869f7d7a332a94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a5b5f1204969b4c7fd1900c8fb0effe"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga5a5b5f1204969b4c7fd1900c8fb0effe">Cy_PDM_PCM_ClearFifo</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base)</td></tr>
<tr class="memdesc:ga5a5b5f1204969b4c7fd1900c8fb0effe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the output data FIFO, removing all data words from the FIFO.  <a href="#ga5a5b5f1204969b4c7fd1900c8fb0effe">More...</a><br /></td></tr>
<tr class="separator:ga5a5b5f1204969b4c7fd1900c8fb0effe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga93d86ba7f06b583502f1300eafde9783"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga93d86ba7f06b583502f1300eafde9783">Cy_PDM_PCM_ReadFifo</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *base)</td></tr>
<tr class="memdesc:ga93d86ba7f06b583502f1300eafde9783"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads ("pops") one word from the output data FIFO.  <a href="#ga93d86ba7f06b583502f1300eafde9783">More...</a><br /></td></tr>
<tr class="separator:ga93d86ba7f06b583502f1300eafde9783"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga314bd648e5d698434112c854cb5429c5"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga314bd648e5d698434112c854cb5429c5">Cy_PDM_PCM_EnableSoftMute</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base)</td></tr>
<tr class="memdesc:ga314bd648e5d698434112c854cb5429c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables soft mute.  <a href="#ga314bd648e5d698434112c854cb5429c5">More...</a><br /></td></tr>
<tr class="separator:ga314bd648e5d698434112c854cb5429c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaae3880fde4329796d81fdd388db4cbb1"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#gaae3880fde4329796d81fdd388db4cbb1">Cy_PDM_PCM_DisableSoftMute</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base)</td></tr>
<tr class="memdesc:gaae3880fde4329796d81fdd388db4cbb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables soft mute.  <a href="#gaae3880fde4329796d81fdd388db4cbb1">More...</a><br /></td></tr>
<tr class="separator:gaae3880fde4329796d81fdd388db4cbb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29717d8708222e5942c76bd388629d65"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga29717d8708222e5942c76bd388629d65">Cy_PDM_PCM_FreezeFifo</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base)</td></tr>
<tr class="memdesc:ga29717d8708222e5942c76bd388629d65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Freezes the RX FIFO (Debug purpose).  <a href="#ga29717d8708222e5942c76bd388629d65">More...</a><br /></td></tr>
<tr class="separator:ga29717d8708222e5942c76bd388629d65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab2fe46c74550514d32a5a49e2bc6d7b7"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#gab2fe46c74550514d32a5a49e2bc6d7b7">Cy_PDM_PCM_UnfreezeFifo</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *base)</td></tr>
<tr class="memdesc:gab2fe46c74550514d32a5a49e2bc6d7b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unfreezes the RX FIFO (Debug purpose).  <a href="#gab2fe46c74550514d32a5a49e2bc6d7b7">More...</a><br /></td></tr>
<tr class="separator:gab2fe46c74550514d32a5a49e2bc6d7b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa21539ce7fe7537bc756732e20d0d4c6"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#gaa21539ce7fe7537bc756732e20d0d4c6">Cy_PDM_PCM_ReadFifoSilent</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *base)</td></tr>
<tr class="memdesc:gaa21539ce7fe7537bc756732e20d0d4c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the RX FIFO silent (without touching the FIFO function).  <a href="#gaa21539ce7fe7537bc756732e20d0d4c6">More...</a><br /></td></tr>
<tr class="separator:gaa21539ce7fe7537bc756732e20d0d4c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8439be1f0bd2fb07c7d7e6cbe93f4144"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pdm__pcm__functions.html#ga8439be1f0bd2fb07c7d7e6cbe93f4144">Cy_PDM_PCM_GetCurrentState</a> (<a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *base)</td></tr>
<tr class="memdesc:ga8439be1f0bd2fb07c7d7e6cbe93f4144"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current PDM-PCM state (running/stopped).  <a href="#ga8439be1f0bd2fb07c7d7e6cbe93f4144">More...</a><br /></td></tr>
<tr class="separator:ga8439be1f0bd2fb07c7d7e6cbe93f4144"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga72f994cbd634988b0016f464720b3559"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga72f994cbd634988b0016f464720b3559">&#9670;&nbsp;</a></span>Cy_PDM_PCM_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__pdm__pcm__enums.html#ga8ef640550e81684b9c1b7a8af1cfd355">cy_en_pdm_pcm_status_t</a> Cy_PDM_PCM_Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__pdm__pcm__config__t.html">cy_stc_pdm_pcm_config_t</a> const *&#160;</td>
          <td class="paramname"><em>config</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize the PDM-PCM module. </p>
<dl class="section pre"><dt>Precondition</dt><dd>If the PDM-PCM module is initialized previously, the <a class="el" href="group__group__pdm__pcm__functions.html#gab516ee1cbdb2327b995d6ea079ad6209">Cy_PDM_PCM_DeInit()</a> must be called before calling this function.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address </td></tr>
    <tr><td class="paramname">config</td><td>The pointer to a configuration structure. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>error / status code. See <a class="el" href="group__group__pdm__pcm__enums__v2.html#ga8ef640550e81684b9c1b7a8af1cfd355">cy_en_pdm_pcm_status_t</a>.</dd></dl>
<p>An example of a configuration structure: </p><div class="fragment"><div class="line"><span class="keyword">const</span> <a class="code" href="structcy__stc__pdm__pcm__config__t.html">cy_stc_pdm_pcm_config_t</a> PDM_PCM_config =</div><div class="line">{</div><div class="line">    <span class="comment">/* .clkDiv                 = */</span><a class="code" href="group__group__pdm__pcm__enums.html#ggaa27739a09b270827f49869f20c9d2ecba693fd2bda6ca858fdf4d94ca97f8b6fc">CY_PDM_PCM_CLK_DIV_BYPASS</a>,</div><div class="line">    <span class="comment">/* .mclkDiv                = */</span><a class="code" href="group__group__pdm__pcm__enums.html#ggaa27739a09b270827f49869f20c9d2ecbaf5cbc3da6dbf41f45932333351e299b6">CY_PDM_PCM_CLK_DIV_1_2</a>,</div><div class="line">    <span class="comment">/* .ckoDiv                 = */</span>3U,</div><div class="line">    <span class="comment">/* .ckoDelay               = */</span>0U,</div><div class="line">    <span class="comment">/* .sincDecRate            = */</span>0x20U,</div><div class="line">    <span class="comment">/* .chanSelect             = */</span><a class="code" href="group__group__pdm__pcm__enums.html#gga1a5b2dac3a8f00ab2d096c0448aa34e4a0c12112db79eeac2ae002bf1e01b9fb2">CY_PDM_PCM_OUT_STEREO</a>,</div><div class="line">    <span class="comment">/* .chanSwapEnable         = */</span><span class="keyword">false</span>,</div><div class="line">    <span class="comment">/* .highPassFilterGain     = */</span>8U,</div><div class="line">    <span class="comment">/* .highPassDisable        = */</span><span class="keyword">false</span>,</div><div class="line">    <span class="comment">/* .softMuteCycles         = */</span><a class="code" href="group__group__pdm__pcm__enums.html#ggad60ecc3b7b9d0ae7f448438f66699cb9a388ddf2156a060132a4a9bbc4c34e121">CY_PDM_PCM_SOFT_MUTE_CYCLES_96</a>,</div><div class="line">    <span class="comment">/* .softMuteFineGain       = */</span><span class="keyword">false</span>,</div><div class="line">    <span class="comment">/* .softMuteEnable         = */</span><span class="keyword">false</span>,</div><div class="line">    <span class="comment">/* .wordLen                = */</span><a class="code" href="group__group__pdm__pcm__enums.html#gga97622d82ab2e429e1b8486428f22e266a99bdeef4802e95f8780cf682a09073d5">CY_PDM_PCM_WLEN_16_BIT</a>,</div><div class="line">    <span class="comment">/* .signExtension          = */</span><span class="keyword">false</span>,</div><div class="line">    <span class="comment">/* .gainLeft               = */</span><a class="code" href="group__group__pdm__pcm__enums.html#ggaadc731486c068307198cd76e1283432fa1e25122fd97a1bd2eb85e4bb9cdd1860">CY_PDM_PCM_BYPASS</a>,</div><div class="line">    <span class="comment">/* .gainRight              = */</span><a class="code" href="group__group__pdm__pcm__enums.html#ggaadc731486c068307198cd76e1283432fa1e25122fd97a1bd2eb85e4bb9cdd1860">CY_PDM_PCM_BYPASS</a>,</div><div class="line">    <span class="comment">/* .rxFifoTriggerLevel     = */</span>32U,</div><div class="line">    <span class="comment">/* .dmaTriggerEnable       = */</span><span class="keyword">false</span>,</div><div class="line">    <span class="comment">/* .interruptMask          = */</span><a class="code" href="group__group__pdm__pcm__macros__interrupt__masks.html#ga3c99bb35b813ec86c6308dee5c827a5b">CY_PDM_PCM_INTR_RX_TRIGGER</a></div><div class="line">};</div></div><!-- fragment -->
</div>
</div>
<a id="gab516ee1cbdb2327b995d6ea079ad6209"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab516ee1cbdb2327b995d6ea079ad6209">&#9670;&nbsp;</a></span>Cy_PDM_PCM_DeInit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_PDM_PCM_DeInit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Uninitializes the PDM-PCM module. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga4ea860b9ffa3f8c9fd3fcd1d42a6df8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ea860b9ffa3f8c9fd3fcd1d42a6df8a">&#9670;&nbsp;</a></span>Cy_PDM_PCM_SetGain()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_PDM_PCM_SetGain </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__pdm__pcm__enums.html#ga3f28a6dc09f7e9046984e99400290ec5">cy_en_pdm_pcm_chan_select_t</a>&#160;</td>
          <td class="paramname"><em>chan</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__pdm__pcm__enums.html#gaadc731486c068307198cd76e1283432f">cy_en_pdm_pcm_gain_t</a>&#160;</td>
          <td class="paramname"><em>gain</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the gain factor to the left or right channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address.</td></tr>
    <tr><td class="paramname">chan</td><td>The channel selector for gain setting <a class="el" href="group__group__pdm__pcm__enums.html#ga3f28a6dc09f7e9046984e99400290ec5">cy_en_pdm_pcm_chan_select_t</a>.</td></tr>
    <tr><td class="paramname">gain</td><td>Gain for the selected channel <a class="el" href="group__group__pdm__pcm__enums.html#gaadc731486c068307198cd76e1283432f">cy_en_pdm_pcm_gain_t</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga70509bf557fcfc3232d29f2f409f86cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70509bf557fcfc3232d29f2f409f86cb">&#9670;&nbsp;</a></span>Cy_PDM_PCM_GetGain()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__pdm__pcm__enums.html#gaadc731486c068307198cd76e1283432f">cy_en_pdm_pcm_gain_t</a> Cy_PDM_PCM_GetGain </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__pdm__pcm__enums.html#ga3f28a6dc09f7e9046984e99400290ec5">cy_en_pdm_pcm_chan_select_t</a>&#160;</td>
          <td class="paramname"><em>chan</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves the current gain factor of the left or right channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address.</td></tr>
    <tr><td class="paramname">chan</td><td>The channel selector for gain setting <a class="el" href="group__group__pdm__pcm__enums.html#ga3f28a6dc09f7e9046984e99400290ec5">cy_en_pdm_pcm_chan_select_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Gain of the selected channel <a class="el" href="group__group__pdm__pcm__enums.html#gaadc731486c068307198cd76e1283432f">cy_en_pdm_pcm_gain_t</a>. </dd></dl>

</div>
</div>
<a id="ga4c9af29264496305f3d53886fda26b94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c9af29264496305f3d53886fda26b94">&#9670;&nbsp;</a></span>Cy_PDM_PCM_DeepSleepCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> Cy_PDM_PCM_DeepSleepCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> const *&#160;</td>
          <td class="paramname"><em>callbackParams</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a>&#160;</td>
          <td class="paramname"><em>mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is an example callback function that can be used at the application layer to manage the PDM-PCM operation before entering and after exiting Deep Sleep mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">callbackParams</td><td>The structure with the syspm callback parameters, see <a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a>.</td></tr>
    <tr><td class="paramname">mode</td><td>Callback mode, see <a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>syspm return status, see <a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> </dd></dl>

</div>
</div>
<a id="ga23a191df6d51589e9d459e51a6a7af8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga23a191df6d51589e9d459e51a6a7af8b">&#9670;&nbsp;</a></span>Cy_PDM_PCM_Enable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_PDM_PCM_Enable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the PDM-PCM data conversion. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga16636b0a3e4032d53b595525e5c34de3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga16636b0a3e4032d53b595525e5c34de3">&#9670;&nbsp;</a></span>Cy_PDM_PCM_Disable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_PDM_PCM_Disable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables the PDM-PCM data conversion. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaecd6316cef42b4c9d31b38aad0c222e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaecd6316cef42b4c9d31b38aad0c222e6">&#9670;&nbsp;</a></span>Cy_PDM_PCM_SetInterruptMask()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_PDM_PCM_SetInterruptMask </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>interrupt</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets one or more PDM-PCM interrupt factor bits (sets the INTR_MASK register). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address </td></tr>
    <tr><td class="paramname">interrupt</td><td>Interrupt bit mask <a class="el" href="group__group__pdm__pcm__macros__interrupt__masks.html">Interrupt Masks</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga083bc3c1e12b8f305cc762d03fa47f0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga083bc3c1e12b8f305cc762d03fa47f0f">&#9670;&nbsp;</a></span>Cy_PDM_PCM_GetInterruptMask()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_PDM_PCM_GetInterruptMask </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the PDM-PCM interrupt mask (a content of the INTR_MASK register). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The interrupt bit mask <a class="el" href="group__group__pdm__pcm__macros__interrupt__masks.html">Interrupt Masks</a>. </dd></dl>

</div>
</div>
<a id="gacb7aa88956b61348b096897f16e969c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacb7aa88956b61348b096897f16e969c4">&#9670;&nbsp;</a></span>Cy_PDM_PCM_GetInterruptStatusMasked()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_PDM_PCM_GetInterruptStatusMasked </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the status of enabled (masked) PDM-PCM interrupt sources. </p>
<p>(an INTR_MASKED register).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The interrupt bit mask <a class="el" href="group__group__pdm__pcm__macros__interrupt__masks.html">Interrupt Masks</a>. </dd></dl>

</div>
</div>
<a id="ga65ff50ea418ef957c66f37ce6737ec0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga65ff50ea418ef957c66f37ce6737ec0a">&#9670;&nbsp;</a></span>Cy_PDM_PCM_GetInterruptStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_PDM_PCM_GetInterruptStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the status of PDM-PCM interrupt sources (an INTR register). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The interrupt bit mask <a class="el" href="group__group__pdm__pcm__macros__interrupt__masks.html">Interrupt Masks</a>. </dd></dl>

</div>
</div>
<a id="ga9519b93d2271e63fc4fbce99cc555d5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9519b93d2271e63fc4fbce99cc555d5e">&#9670;&nbsp;</a></span>Cy_PDM_PCM_ClearInterrupt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_PDM_PCM_ClearInterrupt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>interrupt</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears one or more PDM-PCM interrupt statuses (sets an INTR register's bits). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address </td></tr>
    <tr><td class="paramname">interrupt</td><td>The interrupt bit mask <a class="el" href="group__group__pdm__pcm__macros__interrupt__masks.html">Interrupt Masks</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gac3692d34425f88eb231a24a48602027c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac3692d34425f88eb231a24a48602027c">&#9670;&nbsp;</a></span>Cy_PDM_PCM_SetInterrupt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_PDM_PCM_SetInterrupt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>interrupt</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets one or more interrupt source statuses (sets an INTR_SET register). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
    <tr><td class="paramname">interrupt</td><td>The interrupt bit mask <a class="el" href="group__group__pdm__pcm__macros__interrupt__masks.html">Interrupt Masks</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaeee49f0677e0c628aa869f7d7a332a94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeee49f0677e0c628aa869f7d7a332a94">&#9670;&nbsp;</a></span>Cy_PDM_PCM_GetNumInFifo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint8_t Cy_PDM_PCM_GetNumInFifo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the current number of used words in the output data FIFO. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current number of used FIFO words (range is 0 - 254). </dd></dl>

</div>
</div>
<a id="ga5a5b5f1204969b4c7fd1900c8fb0effe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5a5b5f1204969b4c7fd1900c8fb0effe">&#9670;&nbsp;</a></span>Cy_PDM_PCM_ClearFifo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_PDM_PCM_ClearFifo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Resets the output data FIFO, removing all data words from the FIFO. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga93d86ba7f06b583502f1300eafde9783"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga93d86ba7f06b583502f1300eafde9783">&#9670;&nbsp;</a></span>Cy_PDM_PCM_ReadFifo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_PDM_PCM_ReadFifo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads ("pops") one word from the output data FIFO. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The data word. </dd></dl>

</div>
</div>
<a id="ga314bd648e5d698434112c854cb5429c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga314bd648e5d698434112c854cb5429c5">&#9670;&nbsp;</a></span>Cy_PDM_PCM_EnableSoftMute()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_PDM_PCM_EnableSoftMute </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables soft mute. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaae3880fde4329796d81fdd388db4cbb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae3880fde4329796d81fdd388db4cbb1">&#9670;&nbsp;</a></span>Cy_PDM_PCM_DisableSoftMute()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_PDM_PCM_DisableSoftMute </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables soft mute. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga29717d8708222e5942c76bd388629d65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga29717d8708222e5942c76bd388629d65">&#9670;&nbsp;</a></span>Cy_PDM_PCM_FreezeFifo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_PDM_PCM_FreezeFifo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Freezes the RX FIFO (Debug purpose). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gab2fe46c74550514d32a5a49e2bc6d7b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab2fe46c74550514d32a5a49e2bc6d7b7">&#9670;&nbsp;</a></span>Cy_PDM_PCM_UnfreezeFifo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_PDM_PCM_UnfreezeFifo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unfreezes the RX FIFO (Debug purpose). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaa21539ce7fe7537bc756732e20d0d4c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa21539ce7fe7537bc756732e20d0d4c6">&#9670;&nbsp;</a></span>Cy_PDM_PCM_ReadFifoSilent()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_PDM_PCM_ReadFifoSilent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads the RX FIFO silent (without touching the FIFO function). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>Pointer to PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FIFO value. </dd></dl>

</div>
</div>
<a id="ga8439be1f0bd2fb07c7d7e6cbe93f4144"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8439be1f0bd2fb07c7d7e6cbe93f4144">&#9670;&nbsp;</a></span>Cy_PDM_PCM_GetCurrentState()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_PDM_PCM_GetCurrentState </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_p_d_m___type.html">PDM_Type</a> const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the current PDM-PCM state (running/stopped). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the PDM-PCM instance address. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current state (CMD register). </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
